4D Analytics

Web Configuration

Last updated: July 10, 2020

Web Configuration allows the user to make some choices relating to how the product is displayed, amend client/contact information, and alter web application specific settings on a per organisation basis.

The configuration is split into sections:

  • Alarms
  • Contact Details
  • Dashboard Tabs
  • File Manager
  • Login Page
  • Map
  • Page Look
  • Reporting
  • Site Information Administration
  • Symbols
  • Tree Structure
  • Workbook
  • Workflow Alarms

The drop down box in the top right corner of the page allows the user to filter out a particular section.

SuperUsers will have the added ability to customise web configuration for any organisation. All other users will only be able to alter the organisation that they belong to.

The configuration table consists of 3 columns:

  1. "Web Config Element Name" – Identification of the configurable option
  2. "Config Element Default Value" – The default configuration.
  3. "Organisation Override Value" – Manually customise the configuration to override the default.

Any images to be used in the override section must be present in the organisations "Custom Image Folder" (within "File Manager") or within the web/images folder of the web server.

Any changes made are automatically saved when the return key is pressed, or focus changes to a different field.

Customisation

ALARMS

This section relates to the icons that appear on the alarm list ("Alarm Summary" widget, or Administration>Alarm Management page).

Element Name Description
Alarm Icon for Unacknowledged Enter an image that will appear in the Status column for any new, unacknowledged alarms.
Alarm Icon for Acknowledged Enter an image that will appear in the Status column once an alarm has been acknowledged.
Alarm Icon for Cleared Enter an image that will appear in the Status column once an alarm has been cleared.
Alarm Icon for Detail Enter an image that will appear for the detail column when no email or SMS has been sent.
Alarm Icon for Email Notification Enter an image that will appear in the detail column to inform that an alarm email has been triggered.
Alarm Icon for SMS and Email Notification Enter an image that will appear in the detail column to inform that an alarm SMS and email has been triggered.
Alarm Icon for SMS Notification Enter an image that will appear in the detail column to inform that an alarm SMS has been triggered.
Alarm Page Refresh (mins) Enter the time in minutes it takes for the Current Alarms page to refresh.

CONTACT DETAILS

This displays the contact details for the organisation that appear in the "Contact Us" link in the Help menu.

Each field is self-explanatory.

  • Web Contact Address Title
  • Web Contact Address Line 1
  • Web Contact Address Line 2
  • Web Contact Address Line 3
  • Web Contact Address Line 4
  • Web Contact Email
  • Web Contact Fax
  • Web Contact Phone

DATE FORMAT

To adjust the date format for any instance of a date within Data Workpack, including exported Excel templates, choose either dd-mm-yyyy (default) or mm-dd-yyyy.

DASHBOARD TABS

The section relates to the Dashboard Navigation treeview.

Element Name Description
Dash Tabs has tree property list Whether or not the Dashboard navigation tree has a drop-down above it.
Dash Tabs tree property list default sort If enabled (above), this is the default sort order for the drop-down.
Dash Tabs Tree Sites Fetch Level Choose the container level in the hierarchy that is considered to be your site level. Org (Level 0) -> Region (Level 1) -> Site (Level 2). In this example you would enter 2 Org (Level 0) -> Site (Level 1). In this example you would enter 1

DTE SETTINGS

This section relates to items that affect the behaviour of the Digital Twin Explorer and its sub-pages.

Element Name Description
Decimal Places Enter the number of decimal places to display for values within:
  • Selection table
  • Find points table
  • Configure Points table (tab - Latest Values)
  • Engineering Charts - Show As Table
  • Data Workbook - Default "Decimal Places" setting

FILE MANAGER

This section is applicable to the File Manager folder paths.

Element Name Description
Custom Image Folder Folder on the webserver to use as the "Custom Image" folder.
Custom Jars Folder Folder on the webserver to use as the "Custom Jars" folder.
Document Folder Folder on the webserver to use as the "Document" folder.
Map Data Folder Folder on the webserver to use as the "Map Data" folder.
Mimics Image Upload Folder Folder on the webserver to use as the "Mimics Image Upload" folder.
Multimedia Folder Folder on the webserver to use as the "Multimedia" folder.
PDF Document Folder Folder on the webserver to use as the "PDF Document" folder.
Spreadsheet Folder Folder on the webserver to use as the "Spreadsheet" folder.

LOGIN PAGE

This section allows certain areas of the login page to be customised.

Advanced: If you need a different login for each organisation then you can create a new directory on the web server and pass in the OrgName parameter on the URL.

Element Name Description
Login Background Image Select the login background image to display.
Login Heading Select the login Heading Text.
Login Left Message Footer Line Enter the footer text of the address.
Login Left Message Header Line Enter the header text of the address.
Login Left Message Line 1 Enter line 1 text of the address.
Login Left Message Line 2 Enter line 2 text of the address.
Login Left Message Line 3 Enter line 3 text of the address.
Login Left Message Line 4 Enter line 4 text of the address.
Login Show Footer Choose whether or not to display the footer.
Login Show Guest Message Set to True to display the following message at the base of the login page: Please Note: The guest password changes on a regular basis. If your password has expired, please call your Bentley contact.
Element Name Description
Password refresh period The period (days) after which all passwords within the organisation need to be reset. Setting this to 0 means that passwords will never expire.
Password refresh period limit Once the reset period has been reached (based on the "Password refresh period" configuration), you then have x number of days to change the password before the account is locked out. Configure this period here. Setting this to 0 means that the password would expire as soon as the "Password refresh period" was reached - without any reminders being given.

MAP

The items in this section relate to all aspects of the Map widget.

Element Name Description
Map Default Latitude Enter the latitude to centre the default view of the map to.
Map Default Longitude Enter the longitude to centre the default view of the map to.
Map Default Style Choose the map style to display: Auto, Birds Eye, Road.
Map Default Zoom Select the zoom level of the map. The higher the number the greater the zoom.
Map Default Zoom on Single Site Set the zoom level for the map on a single site.

PAGE LOOK

This section identifies application, grid and dynamic chart themes.

Element Name Description
Grid Theme (DHTMLX) Select the theme for grids used within the application.
Dynamic Chart Theme Select the theme for the Dynamic Chart widgets and the Engineering Chart.
Page Theme Select the theme for the whole application.
User Logo Select the image which will be displayed in the top-right of every page and dashboard below the top banner options.
Element Name Description
Allow HTML in Messages Used with the Message Board widget. Setting this to true allows the display of HTML within the widget.

REPORTING

The Reporting options here refer to the "Custom Table" widget and the "Report" functionality.

Element Name Description
Reporting Enable Views By default the reporting solution will not give access to data out with the existing database. Setting this option to True will allow report creators to pull in data directly from external systems by creating database views and functions.
Use Manual Point Entry The manual point entry option is set to False by default. It can be set to True when there are a considerable number of points within the system and the drop down list within the report function takes too long to populate. When set to True, the user must type the point name manually. It is faster but there is more risk of typing the point name wrong.

SITE INFORMATION ADMINISTRATION

This section relates to the Site Information page that contains a list of all sites within an Organisation.

Element Name Description
Column 1 heading Enter the heading name of the first column pertaining to the site name.
Column 2 heading Enter the heading name of the second column relating to a fixed date field.
Show SMS Number Select whether or not to show the SMS number column.
Show Target Meters Select whether or not to show the target number of meters column.
Show Timezone Select whether or not to show the time zone column for the sites.

SYMBOLS

The Symbols section allows the changing of metrics, currency and temperature symbols to match those commonly used by the main user group.

Element Name Description
Symbol Currency Main Enter the main currency unit for use in the League widget.
Symbol Length Main Enter the main unit of length for use in the League widget.
Symbol Length Main Cubed Enter the main unit of cubed length for use in the League widget.
Symbol Length Main Squared Enter the main unit of squared length For use in the League widget.
Symbol temperature Enter the main unit of temperature for use in the HACCP widget.
Symbol temperature label Enter the default unit of temperature for the HACCP widget.

TREE STRUCTURE
Element Name Description
Tree Structure Friendly Names Use the containers friendly names instead of the actual container names. These are defined in the container description field.
Tree Structure Perspective Level Set the level of depth for perspectives. This limits the number of sequences you can add on the Administration>Perspective Management page.

WORKBOOK
Element Name Description
Date Format Set the default date format for the Data Workbook and the Date column within the DTE - Selection Tool.
Workbook Filter Set the default rows displayed in the Data Workbook.
Workbook Import Action Import New Values or Overwrite Existing Values - Set the default action when importing data into the Data Workbook.

WORKFLOW ALARMS
Element Name Description
Alarm Trigger Reason is Read-only For an alarm trigger definition - If a point has a default alarm reason associated with it, then setting this option to True will prevent the user from changing the reason when making an alarm trigger on this point. The default reason with be shown on the "Alarm Trigger Definition" screen, but will be read-only. For details on setting the default reason, see separate Event Alarms User Guide.